//
// Encog(tm) Core v3.3 - .Net Version
// http://www.heatonresearch.com/encog/
//
// Copyright 2008-2014 Heaton Research, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//   
// For more information on Heaton Research copyrights, licenses 
// and trademarks visit:
// http://www.heatonresearch.com/copyright
//
using System;

namespace Encog.ML.Data.Versatile.Sources
{
    /// <summary>
    /// Defines a data source for the versatile data set.
    /// </summary>
    public interface IVersatileDataSource
    {
        /// <summary>
        /// Read a line from the source.
        /// </summary>
        /// <returns>The values read.</returns>
        String[] ReadLine();

        /// <summary>
        /// Rewind the source back to the beginning.
        /// </summary>
        void Rewind();

        /// <summary>
        /// Obtain the column index for the specified name.
        /// </summary>
        /// <param name="name">The column name.</param>
        /// <returns>The column index, or -1 if not found.</returns>
        int ColumnIndex(string name);

        /// <summary>
        /// Close the source.
        /// </summary>
        void Close();
    }
}
